home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 034a / wa_131.zip / SYSOP.TXT < prev    next >
Text File  |  1991-12-21  |  10KB  |  269 lines
  1.  
  2.                    WIZARD'S ARENA -- RELEASE 1.31
  3.                (C) Copyright 1991 by Douglas Summers
  4.  
  5.                          SYSOP DOCUMENTATION
  6.  
  7.  
  8. ------------
  9. INTRODUCTION
  10. ------------
  11. To all you new users, thank you for trying out Wizard's Arena.  If
  12. you're not a new user, refer to UPGRADE.TXT for instructions on
  13. upgrading to the new version.
  14.  
  15. The Wizard's Arena is a BBS door game, allowing a  number of players
  16. to wander around in a large maze-like area and fight it out, using a
  17. wide variety of spells and a certain amount of  ironmongery.  Further
  18. details on the setting of the game -- and on actual play -- can be
  19. found in the player's documentation.
  20.  
  21.  
  22. ---------------------
  23. BEFORE WE GET STARTED
  24. ---------------------
  25. Check your distribution files.  You should have the following :
  26.  
  27.         WIZARD.EXE     -- the game itself
  28.         WA-UTIL.EXE     -- to install and do daily maintenance
  29.  
  30.         WIZARD.TXT     -- the player documentation
  31.         COMMAND.TXT     -- the on-line quick-help file
  32.         CHANGES.TXT     -- a list of the modifications since 1.00
  33.         SYSOP.TXT     -- this documentation
  34.         COPYRIGH.TXT -- the copyright notice for the game, & legal stuff
  35.         UPGRADE.TXT     -- how to upgrade from older versions
  36.         CONFIG.TXT     -- how to customize the game
  37.  
  38.         DATABASE.ZIP -- the initial game databases (see notes, below)
  39.         DOOR.SYS     -- used to run in LOCAL mode
  40.         README.1ST     -- a file that tells you to read this file.
  41.  
  42. There may also be a README.TXT.  If one exists, you should read
  43. it IMMEDIATELY.  If there isn't one, don't worry about it.  There
  44. may also be an ADS.TXT file, which will be a small file describing
  45. other games you might be interested in.  If it's not there, don't
  46. sweat it particularly, either.
  47.  
  48. Other than README.TXT and/or ADS.TXT, if any of these files are
  49. missing or there are 'extra' files, I suggest you delete this
  50. stuff off your disk and get a copy from a 'known clean' source.
  51.  
  52.  
  53. ---------------------------
  54. SETTING UP (NEW USERS ONLY)
  55. ---------------------------
  56.  
  57. Just follow these simple instructions:
  58.  
  59.     1.    Make a directory for the game.  For example, D:\WIZARD.
  60.  
  61.     2.    Copy all the distribution files into that directory.
  62.         All the files should remain together; the game looks in its
  63.         own directory for the databases and text files (although
  64.         that directory needn't be the CURRENT directory at the
  65.         time the program is run).
  66.  
  67.     3.    Unzip DATABASE.ZIP.
  68.  
  69.     4.    Set up a batch file to run the program.  See the following
  70.         section for details.
  71.           
  72.     5.    Run WA-UTIL.EXE.  This will generate a small file named
  73.         "CONFIG.WA".  (It will also generate a file named
  74.         "REGISTER.ME" that you will need if you decide to register
  75.         the game.)  You should customize the CONFIG file, at the very
  76.         least to specify your BBS's name.  Please refer to CONFIG.TXT
  77.         for details.
  78.  
  79.  
  80. ------------------------- 
  81. SETTING UP THE BATCH FILE
  82. -------------------------
  83. You'll need to make a batch file to call the program with.  The line
  84. actually calls the game can look something like this:
  85.  
  86.         C:\WIZARD\WIZARD C:\PCB\PCBOARD.SYS
  87.  
  88. The directory the game is in doesn't need to be on your path;
  89. of course, your batch file must be.
  90.  
  91. The only parameter to the program is the location (full path-and-
  92. filename) of the door-information file for your BBS.  Different BBS
  93. types use different ones, so if you're not sure how to set this up,
  94. just refer to your BBS documentation.
  95.  
  96. The batch file  should look something like this (this example is for
  97. PCBoard):
  98.  
  99.     C:\WIZARD\WIZARD C:\PCB\PCBOARD.SYS
  100.     board.bat            (or whatever it takes to crank your board back up)
  101.  
  102.  
  103. ----------------------
  104. NETWORK CONSIDERATIONS
  105. ----------------------
  106. Both programs (WIZARD and WA-UTIL) require complete control of the
  107. database;  two nodes can't be running the program at the same
  108. time.  The programs enforce this by creating a semaphore file and
  109. deleting it when the program terminates.  If the program sees this
  110. file, it simply terminates with a 'Sorry, you can't...' sort of
  111. message.
  112. What happens if the system goes down, or the program locks up?  The
  113. semaphore file remains behind, blocking further access.  For this
  114. reason, the file is time-stamped: a semaphore file more than an
  115. hour old is ignored.
  116. For this reason, it is necessary that each machine's time-of-day
  117. clock be more-or-less in sync with the server's.  Chances are,
  118. you're set up that way already.  If you can't guarantee that,
  119. you should manually perform such semaphoring in your batch file and
  120. set WIZARD's automatic semaphoring off.  (See CONFIG.TXT).
  121.   
  122.  
  123. ---------------
  124. RUNNING LOCALLY
  125. ---------------
  126. The game can be run locally simply by calling it directly with a
  127. command-line parameter of "DOOR.SYS".  This causes the game to
  128. use that file (provided with the game) instead of the door-
  129. information file normally employed.  It'll prompt you for a user's
  130. name; any user in the game is available to you.
  131.  
  132.  
  133. -----------
  134. REGISTERING
  135. -----------
  136. Registering the game is pretty easy.  After you've run the WA-UTIL
  137. program, there will be a file named "REGISTER.ME" in the directory
  138. with the WIZARD databases.
  139.  
  140. Read it, fill in the few blanks, and mail it to me (the address
  141. is listed on the form itself) with a $15 (US) check or money order
  142. enclosed.  Feel free to use the comment area for kudos or brickbats.
  143.  
  144. After the post office has done its glacial best to lose the letter,
  145. I will return to you (via a postcard) a short sequence of numbers and
  146. some letters (along with my eternal gratitude).  Simply edit your
  147. CONFIG.WA file to have a line in it that says:
  148.  
  149.                 REGISTRATION = XXXXXXXX
  150.      
  151. (where the X's are replaced by the registration sequence I send you).
  152. The game will now 'know' its registered, will be overjoyed to see
  153. that you support a starving shareware artist, and will gleefully
  154. permit the registration-specific parameters to take effect.
  155.  
  156. There aren't any diskettes involved in the registration process;
  157. only a simple code.  In particular, the author doesn't undertake
  158. to distribute newer versions far and wide as they become available.
  159. Announcements on the release of new version are made in appropriate
  160. RIME and InterLink conferences, along with a (short) list of BBS's
  161. that the new version can be downloaded from.
  162.  
  163. Any comments you have about the game are more than welcome,  particularly
  164. if accompanied by cash.  I can be reached via RIME or by mail; my
  165. address is listed in the COPYRIGH.TXT file.
  166.  
  167. Please Note: The key sequence, and therefore the registration sequence,
  168. are based partly on the BBS name you set up in CONFIG.WA.  If you
  169. need to change the name of your board, you'll need a new registration
  170. sequence; contact the author in this event.
  171.  
  172. ---------------
  173. SYSOP FUNCTIONS
  174. ---------------
  175. The author is very much indebted to Rickie Belitz for his excellent
  176. CKIT library for the nuts-and-bolts of door handling.  Since I don't
  177. have the source-code to this shareware library, my ability to support
  178. it is limited.  If any problems come up, though, I'll try.  I've culled
  179. a small amount of documentation from his text files, to describe the
  180. features that my program provides via his library.
  181.  
  182. Certain functions are allowed to the sysop while the remote user is
  183. running the door.
  184.  
  185. These (as drawn from his documentation) are:
  186.  
  187.     Function Key
  188.     ------------
  189.         F5            Shell to DOS
  190.         F8            Return user to system
  191.         F9            Toggle display
  192.         F3            Toggle Printer        (PCBoard only)
  193.         F4            Toggle Bell            (PCBoard only)
  194.         F7            Toggle Caller Alarm    (PCBoard Only)
  195.         Alt-H        Toggle status line
  196.         Alt-N        Toggle sysop on next
  197.         Alt-X        Exit to DOS after call
  198.  
  199.  
  200. ------------------
  201. IF ERRORS OCCUR...
  202. ------------------
  203. If an error should happen during game-play, the user will be
  204. dumped back to the BBS and a file named ERRORS.OUT will contain
  205. specific information about the error.
  206.  
  207. Try fixing the obvious things -- low RAM, not enough file handles,
  208. and so on.  If you're running on a network, make sure that only
  209. one node at a time can be in the game.  Then try restoring from
  210. the backup that you so    prudently keep.  If the problem persists,
  211. try running the WA-UTIL program; it does a small amount of error-
  212. detection and -correction,    even when it doesn't need to convert
  213. anything.
  214.  
  215. If none of these things work, contact the author.  He'll try to
  216. sort it out.
  217.  
  218. After errors are resolved, you might want to delete (or at least
  219. edit) the error-log, ERRORS.OUT.  The game makes no effort to do so.
  220.  
  221.  
  222. ----------
  223. BACKING UP
  224. ----------
  225. If the program bombs, it might be nice to be able to restore from
  226. an archive to a state prior to the error.  Therefore, it'd be
  227. nice to back up the databases from time to time.  
  228. It isn't a good idea to back up EVERY time someone logs in,
  229. though -- much time is wasted.  WIZARD.EXE (and WA-UTIL.EXE, see below)
  230. will exit with an errorlevel of 100 if it does the daily maintenance.
  231.  
  232. You can use this to perform backups on a daily basis. For example:
  233.  
  234.     C:\WIZARD\WIZARD C:\PCB\PCBOARD.SYS
  235.     IF ERRORLEVEL 100 GOTO DAILY
  236.     GOTO NO_BACKUP
  237.     :DAILY
  238.     PKZIP DAILY C:\WIZARD\WA0*.*
  239.     GOTO NO_BACKUP
  240.     :NO_BACKUP
  241.  
  242. The only files that need to be archived are the databases, which
  243. have a filespec "WA*.*".
  244.  
  245.  
  246. -----------------
  247. DAILY MAINTENANCE
  248. -----------------
  249. The first user to enter the game on a given day triggers the daily
  250. maintenance; this is a process that distributes random monsters and
  251. items, gives everyone their AP/FP allotment and moves the NPCs.
  252.  
  253. It can take from a few seconds to a few minutes, depending on the 
  254. number of NPCs wandering around and the speed of your computer;
  255. you might, therefore, want to do it off-line.
  256.  
  257. To this end, the program WA-UTIL.EXE will run daily maintenance if
  258. there is any need to do so.  It takes the same parameters as
  259. WIZARD.EXE does, but ignores the ones not relating to daily
  260. maintenance.  All it does is run the daily maintenance, if it hasn't
  261. already been run that day (by WA-UTIL.EXE or WIZARD.EXE).
  262.  
  263. I recommend that you simply put a call to it in the 'system event'
  264. stuff (which is often used for getting/processing mail and so forth).
  265. That way, your users will never have to sit through it.
  266.  
  267. Use of WA-UTIL.EXE this way is entirely optional; if it doesn't do
  268. the daily maintenance on schedule, WIZARD.EXE will.
  269.